cs-notifications-papi

(0 reviews)

📘 Documentación de la API - CS Notifications PAPI

📌 Descripción General

El CS Notifications Process API (PAPI) proporciona un canal estandarizado para el envío de mensajes de correo electrónico y SMS, así como para la consulta de trazabilidad (tracking) de notificaciones.

La API abstrae la lógica de negocio y simplifica la integración con servicios externos de mensajería (como Twilio), garantizando seguridad, escalabilidad y reutilización dentro de la plataforma de integración de Fundación Grupo Social.

🔒 Seguridad

Esta API se encuentra protegida con los siguientes mecanismos:

Client ID EnforcementRequiere el uso de client_id y client_secret en las cabeceras de la petición.
OAuth 2.0Se requiere un token de acceso válido en la cabecera:Authorization: Bearer

📌 El token debe ser solicitado previamente al Authorization Server configurado para la organización.

🌐 Base URI

https://cs-notifications-papi-{env}-v1.us-e1.cloudhub.io/api/

🔧 Parámetros de entorno (`env`)

dev → Entorno de desarrollo
qa → Entorno de calidad
prod → Entorno productivo

📑 Convenciones de Consumo

Todas las peticiones deben realizarse bajo el protocolo seguro HTTPS.
El contenido de las peticiones y respuestas es en JSON, salvo casos específicos como carga de archivos (multipart/form-data).
Los encabezados mínimos requeridos:Content-Type: application/jsonclient_id: client_secret: Authorization: Bearer

⚠️ Manejo de Errores

La API implementa una política estándar de manejo de errores basada en la librería común:

400 Bad Request → Error en los parámetros enviados.
401 Unauthorized → Token inválido o no enviado.
403 Forbidden → Credenciales inválidas o sin permisos.
404 Not Found → Recurso no encontrado.
500 Internal Server Error → Error inesperado en el servidor.

Los errores retornan un cuerpo en formato JSON con más detalles.

Ejemplo:

{
  "error": "invalid_request",
  "description": "The field 'mail_to' is required."
}

🛠 Reutilización de Fragments

Para garantizar estandarización, esta API hace uso de la Fragment Library Commons, que provee:

Encabezados comunes (commons.request-headers)
Códigos de error HTTP (commons.http-error-codes)
Plantillas de respuesta (commons.get-record, commons.post-record)

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

Documentación actualizada por última vez: Septiembre 2025
Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

```